---
title: IPolicyHeaderDataProvider
summary: API reference for IPolicyHeaderDataProvider.
status: draft
owner: SAIF Claims BOF team
last_reviewed: 2026-08-21
library: SAIF.Business.Policy
reference_type: embedded
---

# IPolicyHeaderDataProvider

Defines the contract that policy-header views consume when they need a policy's identifying fields, relationship context, associations, help text, and messages from a single provider object.

## Purpose
- Give UI-facing code one contract for the core values shown in a policy header.
- Surface association rows and a selected association parent alongside the basic policy identity fields.
- Pair raw header data with a `PolicyHeaderHelpTextCollection` so applications can supply context-specific labels and hints.

## Context
- Namespace: `SAIF.Business.Policy`
- Assembly/package: `SAIF.Business.Policy`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `PolicyNumber` | `ReadOnly Property PolicyNumber As Decimal` | Identifies the policy whose header data is being displayed. |
| `PolicyName` | `ReadOnly Property PolicyName As String` | Supplies the display name shown for the policy in header views. |
| `LegalName` | `ReadOnly Property LegalName As String` | Supplies the insured's legal name for header display. |
| `StatusDescription` | `ReadOnly Property StatusDescription As String` | Supplies the current policy-status text shown to users. |
| `MarketTypeDescription` | `ReadOnly Property MarketTypeDescription As String` | Supplies a display-ready market-type label. |
| `AgencyName` | `ReadOnly Property AgencyName As String` | Supplies the agency name presented in the header. |
| `RelationshipDescription` | `ReadOnly Property RelationshipDescription As String` | Supplies the current policy relationship label shown beside the header. |
| `RateAccountNumber` | `ReadOnly Property RateAccountNumber As Decimal` | Supplies the rate-account identifier associated with the header. |
| `PolicyAssociations` | `ReadOnly Property PolicyAssociations As IEnumerable(Of IPolicyHeaderAssociation)` | Supplies the association rows that a header UI can list for the current policy. |
| `PolicyAssociationParent` | `ReadOnly Property PolicyAssociationParent(ByVal inAssociationType As IPolicyAssociationType) As IPolicyHeaderAssociation` | Returns the parent association row for a specific association type. |
| `HelpTexts` | `ReadOnly Property HelpTexts As PolicyHeaderHelpTextCollection` | Supplies the label/help-text bundle that explains the header fields to users. |
| `Messages` | `ReadOnly Property Messages As IEnumerable(Of String)` | Supplies additional header messages or notices to display with the policy. |

## Behavioral notes
- The interface intentionally mixes scalar header data and association data so a single provider can back a full header experience.
- `HelpTexts` separates wording concerns from the raw data contract, allowing applications to vary labels without changing the provider shape.

## Constraints and usage notes
- Implementations are responsible for populating both the base fields and the association/help-text collections; this library provides only the contract.

## Sources
- `SAIF.Business.Policy\IPolicyHeaderDataProvider.vb`